home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / elv18src.zip / doc / options.ms < prev    next >
Text File  |  1994-01-16  |  25KB  |  568 lines
  1. .Go 5 "OPTIONS"
  2. .PP
  3. Options may be set or examined via the colon command "set".
  4. The values of options will affect the operation of later commands.
  5. .PP
  6. For convenience, options have both a long descriptive name and a short name
  7. which is easy to type.
  8. You may use either name interchangeably.
  9. I like the short names, myself.
  10. .PP
  11. There are three types of options: Boolean, string, and numeric.
  12. Boolean options are made TRUE by giving the name of the option as an
  13. argument to the "set" command;
  14. they are made FALSE by prefixing the name with "no".
  15. For example, "set autoindent" makes the autoindent option TRUE,
  16. and "set noautoindent" makes it FALSE.
  17. \*E also allows boolean options to be toggled by prefixing the name with "neg".
  18. So, ":map g :set neglist^M" will cause the <g> key to alternately toggle the
  19. "list" option on and off.
  20. (The "neg" prefix is an extension; the real vi doesn't support it.)
  21. .PP
  22. To change the value of a string or numeric option, pass the "set" command
  23. the name of the option, followed by an "=" sign and the option's new value.
  24. For example, "set tabstop=8" will give the tabstop option a value of 8.
  25. For string options, you may enclose the new value in quotes.
  26. .LD
  27. .ta 1.9i 2.4i 3.8i
  28. .ps +2
  29. \fBNAMES    TYPE    DEFAULT    MEANING\fP
  30. .ps -2
  31. autoindent, ai    Bool    noai    auto-indent during input
  32. autoprint, ap    Bool    ap    in EX, print the current line
  33. autotab, at    Bool    at    auto-indent allowed to use tabs?
  34. autowrite, aw    Bool    noaw    auto-write when switching files
  35. beautify,  bf    Bool    nobf    strip control chars from file?
  36. charattr, ca    Bool    noca    interpret \\fX sequences?
  37. cc, cc    Str    cc="cc -c"    name of the C compiler
  38. columns, co    Num    co=80    width of the screen
  39. digraph, dig    Bool    nodig    recognize digraphs?
  40. directory, dir    Str    dir="/usr/tmp"    where tmp files are kept
  41. edcompatible, ed    Bool    noed    remember ":s//" options
  42. equalprg, ep    Bool    ep="fmt"    program to run for = operator
  43. errorbells, eb    Bool    eb    ring bell on error
  44. exrc, exrc    Bool    noexrc    read "./.exrc" file?
  45. exrefresh, er    Bool    er    write lines individually in EX
  46. flash, vbell    Bool    flash    use visible alternative to bell
  47. flipcase, fc    Str    fc=""    non-ASCII chars flipped by ~
  48. hideformat, hf    Bool    hf    hide text formatter commands
  49. ignorecase, ic    Bool    noic    upper/lowercase match in search
  50. inputmode, im    Bool    noim    start vi in insert mode?
  51. keytime, kt    Num    kt=2    timeout for mapped key entry
  52. keywordprg, kp    Str    kp="ref"    full pathname of shift-K prog
  53. lines, ln    Num    ln=25    number of lines on the screen
  54. list, li    Bool    noli    display lines in "list" mode
  55. magic, ma    Bool    ma    use regular expression in search
  56. make, mk    Str    mk="make"    name of the "make" program
  57. mesg, ms    Bool    ms    allow messages from other users?
  58. modelines, ml    Bool    noml    are modelines processed?
  59. more, more    Bool    more    pause between messages?
  60. nearscroll, ns    Num    ns=15    when to scroll vs. redraw
  61. newfile, new    BOOL    nonew    is current file new?
  62. novice, nov    Bool    nonovice    set options for ease of use
  63. number, nu    Bool    nonumber    show line numbers
  64. paragraphs, para    Str    para="PPppIPLPQP"    names of "paragraph" nroff cmd
  65. prompt, pr    Bool    pr    show ':' prompt in \fIex\fR mode
  66. readonly, ro    Bool    noro    prevent overwriting of orig file
  67. remap, rem    Bool    remap    allow key maps to call key maps
  68. report, re    Num    re=5    report when 5 or more changes
  69. ruler, ru    Bool    noru    display line/column numbers
  70. scroll, sc    Num    sc=12    scroll amount for ^U and ^D
  71. sections, sect    Str    sect="NHSHSSSEse"    names of "section" nroff cmd
  72. shell, sh    Str    sh="/bin/sh"    full pathname of the shell
  73. showmatch, sm    Bool    nosm    show matching ()[]{}
  74. showmode, smd    Bool    nosmd    say when we're in input mode
  75. shiftwidth, sw    Num    sw=8    shift amount for < and >
  76. sidescroll, ss    Num    ss=8    amount of sideways scrolling
  77. sync, sy    Bool    nosy    call sync() often
  78. tabstop, ts    Num    ts=8    width of tab characters
  79. taglength, tl    Num    tl=0    significant chars in tag name
  80. tags, tag    Str    tags="tags" list of tags files
  81. tagstack, tgs    Bool    tgs    enable tagstack?
  82. term, te    Str    te="$TERM"    name of the termcap entry
  83. terse, tr    Bool    notr    give shorter error messages
  84. timeout, to    Bool    to    distinguish <esc> from <arrow>?
  85. warn, wa    Bool    wa    warn for ! if file modified
  86. window, wi    Num    wi=24    lines to redraw after long move
  87. wrapmargin, wm    Num    wm=0    wrap long lines in input mode
  88. wrapscan, ws    Bool    ws    at EOF, searches wrap to line 1
  89. writeany, wr    Bool    nowr    allow :w to clobber files
  90. .DE
  91. .TA
  92. .ne 6
  93. .IP "autoindent, ai"
  94. During input mode, the autoindent option will cause each added line
  95. to begin with the same amount of leading whitespace as the line above it.
  96. Without autoindent, added lines are initially empty.
  97. .IP "autoprint, ap"
  98. This option only affects EX mode.
  99. If the autoprint option on,
  100. and either the cursor has moved to a different line
  101. or the previous command modified the file,
  102. then \*E will print the current line.
  103. .IP "autotab, at"
  104. This option affects the behavior of the autoindent mode.
  105. If autoindent is turned off, then autotab has no effect.
  106. .IP
  107. When autotab is turned on, elvis will use a mixture of spaces and tabs
  108. to create the proper amount of indentation.
  109. This is the default.
  110. .IP
  111. When autotab is turned off, elvis will only use spaces for auto-indent.
  112. \*E will still insert a real tab character when you hit the <Tab> key, though;
  113. the autotab option only affects \fIautomatic\fR indentation.
  114. .IP "autowrite, aw"
  115. When you're editing one file and decide to switch to another
  116. \- via the :tag command, or :next command, perhaps \-
  117. if your current file has been modified,
  118. then \*E will normally print an error message and refuse to switch.
  119. .IP
  120. However, if the autowrite option is on,
  121. then \*E will write the modified version of the current file
  122. and successfully switch to the new file.
  123. .IP "beautify, bf"
  124. This option causes all control characters to be deleted from the text file,
  125. at the time when you start editing it.
  126. If you're already editing a file when you turn on the beautify option,
  127. then that file won't be affected.
  128. .IP cc
  129. The :cc command runs the C compiler.
  130. This option should be set to the name of your compiler.
  131. .IP "charattr, ca"
  132. Many text formatting programs allow you to designate portions of
  133. your text to be underlined, italicized, or boldface by embedding
  134. the special strings \\fU, \\fI, and \\fB in your text.
  135. The special string \\fP marks the end of underlined or boldface text.
  136. .IP
  137. \*E normally treats those special strings just like any other text.
  138. .IP
  139. However, if the charattr option is on, then \*E will interpret
  140. those special strings correctly,
  141. to display underlined or boldface text on the screen.
  142. (This only works, of course, if your terminal can display
  143. underlined and boldface, and if the TERMCAP entry says how to do it.)
  144. .IP "columns, co"
  145. This option shows how wide your screen is.
  146. .IP "digraph, dig"
  147. This option is used to enable/disable recognition of digraphs.
  148. The default value is nodigraph, which means that digraphs will not be
  149. recognized.
  150. .IP "directory, dir"
  151. \*E stores text in temporary files.
  152. This option allows you to control which directory those temporary files will
  153. appear in.
  154. The default is /usr/tmp.
  155. .IP
  156. This option can only be set in a .exrc file;
  157. after that, \*E will have already started making temporary files
  158. in some other directory, so it would be too late.
  159. .IP "edcompatible, ed"
  160. This option affects the behavior of the ":s/regexp/text/options" command.
  161. It is normally off (:se noed) which causes all of the substitution options
  162. to be off unless explicitly given.
  163. .IP
  164. However, with edcompatible on (:se ed), the substitution command remembers
  165. which options you used last time.
  166. Those same options will continue to be used until you change them.
  167. In edcompatible mode, when you explicitly give the name of a
  168. substitution option, you will toggle the state of that option.
  169. .IP
  170. This all seems very strange to me, but its implementation was almost free
  171. when I added the ":&" command to repeat the previous substitution,
  172. so there it is.
  173. .IP "equalprg, ep"
  174. This holds the name & arguments of the external filter program
  175. used the the visual = operator.
  176. The default value is "fmt",
  177. so the = operator will adjust line breaks in text.
  178. .IP "errorbells, eb"
  179. \*E normally rings a bell when you do something wrong.
  180. This option lets you disable the bell.
  181. .IP exrc
  182. This option specifies whether a .exrc file in the current directory
  183. should be executed.
  184. By default, this option is